Skip to content

Use Python uuid.UUID instead of StrictStr#21740

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
RagnaRockGeo:python_uuid_support
Aug 17, 2025
Merged

Use Python uuid.UUID instead of StrictStr#21740
wing328 merged 1 commit intoOpenAPITools:masterfrom
RagnaRockGeo:python_uuid_support

Conversation

@EspenHa
Copy link
Copy Markdown
Contributor

@EspenHa EspenHa commented Aug 13, 2025

This PR will change the Python type hint for uuid fields from StrictStr to uuid.UUID.

Solves #19485.

I essentially just copied the changes suggested by @to-bee in this comment: #19485 (comment) .

Since this will be a breaking change, should it be hidden behind some flag or option? I opened the pull request against the 8.0.x branch, please change this if it is wrong.

@cbornet @tomplus @krjakbrjak @fa0311 @multani

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 16, 2025

@EspenHa thanks for the PR

what about targeting current master by considering this as a bug fix instead?

if later users need strings to represent uuid (for backward compatibility), we will add an option for fallback.

@EspenHa EspenHa changed the base branch from 8.0.x to master August 16, 2025 12:13
@EspenHa
Copy link
Copy Markdown
Contributor Author

EspenHa commented Aug 16, 2025

@wing328 Sure, I updated it to target master now

@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 17, 2025

I essentially just copied the changes suggested by @to-bee in this comment: #19485 (comment) .

did you test the fix locally to confirm it works for your use cases?

@EspenHa
Copy link
Copy Markdown
Contributor Author

EspenHa commented Aug 17, 2025

Yes, I'm using a generated client library based on this PR now, as far as I can tell it works without any issues.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 17, 2025

Good. Let's give it a try

Thanks for the contribution.

@wing328 wing328 merged commit 43d58ee into OpenAPITools:master Aug 17, 2025
46 of 47 checks passed
@wing328 wing328 added this to the 7.15.0 milestone Aug 17, 2025
Goopher pushed a commit to Goopher/openapi-generator that referenced this pull request Sep 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants